Request For Payment Cancellation

The RequestForPaymentCancellation API enables to cancel the payment request initiated by the originator.

Method: POST

{{URL}}/rtp/rpc/TransactionService/RequestForPaymentCancellation

Headers

Name	Value
Content-Type	application/json
Credential	"Basic c3VwcG9ydCsxQG5ldHN5cy1pbmMuY29tOjM5ZDYxOGJkNTVmN5NWQxY2RlNDE5"
Signature	"{{signature}}"

Example

Payload Parameters

Parameter	Description
referenceNumber Mandatory	String Reference number of the outbound Request for Payment Example – "CBWRFP20230808220000124"
caseId Mandatory	String Case ID of payment cancellation request Example – "CASE_RFPC_CBWRFP20230808220000124"
processor Mandatory	String Payment channel through which the transaction happens Example – "FEDNOW"
caseHandler Mandatory	Object
email Mandatory	String Email of the case handler who checks this request Example – "ramesh@test.com"
name Mandatory	String Name of the case handler who checks this request Example – "Ramesh P"
phoneNo Mandatory	String Contact phone number of the case handler who checks this request Example – "+1-5632897456"
prefMethod Mandatory	String Preferable mode of contacting the case handler Example – "PHON"
reason Mandatory	Object
additionalInfo Mandatory	String Reason for cancelling the payment Example – "Invalid creditor"
code Mandatory	String Reason code of the given reason Example – "AC03"

cURL

curl --location '{{URL}}/rtp/rpc/TransactionService/RequestForPaymentCancellation' \
--header 'Content-Type: application/json' \
--data-raw '{"referenceNumber":"CBWRFP20230808220000124","caseId":"CASE_RFPC_CBWRFP20230808220000124","processor":"FEDNOW","caseHandler":{"email":"ramesh@test.com","name":"Ramesh P","phoneNo":"+1-5632897456","prefMethod":"PHON"},"reason":{"additionalInfo":"Invalid creditor","code":"AC03"}}'

C#

var options = new RestClientOptions("{{URL}}")
{
  MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("/rtp/rpc/TransactionService/RequestForPaymentCancellation", Method.Post);
request.AddHeader("Content-Type", "application/json");
var body = @"{
" + "\n" +
@"    ""referenceNumber"": ""CBWRFP20230808220000124"",
" + "\n" +
@"    ""caseId"": ""CASE_RFPC_CBWRFP20230808220000124"",
" + "\n" +
@"    ""processor"": ""FEDNOW"",
" + "\n" +
@"    ""caseHandler"": {
" + "\n" +
@"        ""email"": ""ramesh@test.com"",
" + "\n" +
@"        ""name"": ""Ramesh P"",
" + "\n" +
@"        ""phoneNo"": ""+1-5632897456"",
" + "\n" +
@"        ""prefMethod"": ""PHON""
" + "\n" +
@"    },
" + "\n" +
@"    ""reason"": {
" + "\n" +
@"        ""additionalInfo"": ""Invalid creditor"",
" + "\n" +
@"        ""code"": ""AC03""
" + "\n" +
@"    }
" + "\n" +
@"}";
request.AddStringBody(body, DataFormat.Json);
RestResponse response = await client.ExecuteAsync(request);
Console.WriteLine(response.Content);

Go

package main

import (
  "fmt"
  "strings"
  "net/http"
  "io/ioutil"
)

func main() {

  url := "{{URL}}/rtp/rpc/TransactionService/RequestForPaymentCancellation"
  method := "POST"

  payload := strings.NewReader(`{`+"
"+`
    "referenceNumber": "CBWRFP20230808220000124",`+"
"+`
    "caseId": "CASE_RFPC_CBWRFP20230808220000124",`+"
"+`
    "processor": "FEDNOW",`+"
"+`
    "caseHandler": {`+"
"+`
        "email": "ramesh@test.com",`+"
"+`
        "name": "Ramesh P",`+"
"+`
        "phoneNo": "+1-5632897456",`+"
"+`
        "prefMethod": "PHON"`+"
"+`
    },`+"
"+`
    "reason": {`+"
"+`
        "additionalInfo": "Invalid creditor",`+"
"+`
        "code": "AC03"`+"
"+`
    }`+"
"+`
}`)

  client := &http.Client {
  }
  req, err := http.NewRequest(method, url, payload)

  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("Content-Type", "application/json")

  res, err := client.Do(req)
  if err != nil {
    fmt.Println(err)
    return
  }
  defer res.Body.Close()

  body, err := ioutil.ReadAll(res.Body)
  if err != nil {
    fmt.Println(err)
    return
  }
  fmt.Println(string(body))
}

NodeJs

var https = require('follow-redirects').https;
var fs = require('fs');

var options = {
  'method': 'POST',
  'hostname': '{{URL}}',
  'path': '/rtp/rpc/TransactionService/RequestForPaymentCancellation',
  'headers': {
    'Content-Type': 'application/json'
  },
  'maxRedirects': 20
};

var req = https.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function (chunk) {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });

  res.on("error", function (error) {
    console.error(error);
  });
});

var postData = JSON.stringify({
  "referenceNumber": "CBWRFP20230808220000124",
  "caseId": "CASE_RFPC_CBWRFP20230808220000124",
  "processor": "FEDNOW",
  "caseHandler": {
    "email": "ramesh@test.com",
    "name": "Ramesh P",
    "phoneNo": "+1-5632897456",
    "prefMethod": "PHON"
  },
  "reason": {
    "additionalInfo": "Invalid creditor",
    "code": "AC03"
  }
});

req.write(postData);

req.end();

Request Body (Applicable only for FedNow)

{
    "referenceNumber": "CBWRFP20230808220000124",
    "caseId": "CASE_RFPC_CBWRFP20230808220000124",
    "processor": "FEDNOW",
    "caseHandler": {
        "email": "ramesh@test.com",
        "name": "Ramesh P",
        "phoneNo": "+1-5632897456",
        "prefMethod": "PHON"
    },
    "reason": {
        "additionalInfo": "Invalid creditor",
        "code": "AC03"
    }
}

Response: 200

Response Parameters

Parameter	Description
message	String Notification message for the transaction Example – "success"
rawMessage	String Raw response message related to the transaction encoded in Base64 Example – "Base64 Value of Received Response"
response	String Response received for the given request Example – "JSON Representation of Received Response"
status	String Status of the response Example – "SUCCESS"

Response Body (Applicable only for FedNow)

{
  "message": "success",
  "rawMessage": "Base64 Value of Received Response",
  "response": "JSON Representation of Received Response",
  "status": "SUCCESS"
}